home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / qbbs / hambnk12.zip / HAMBANK.DOC < prev    next >
Text File  |  1990-04-29  |  17KB  |  348 lines
  1.  
  2.           ██   ██   █████   ██▐████  ██▐███    █████   ██▐████  ██  ██
  3.           ██   ██  ██   ██  ██ █ ██  ██   ██  ██   ██  ██   ██  ██▐██
  4.           ██▐████  ██▐████  ██ █ ██  ██▐███   ██▐████  ██   ██  ██▐█
  5.           ██   ██  ██   ██  ██   ██  ██   ██  ██   ██  ██   ██  ██▐██
  6.           ██   ██  ██   ██  ██   ██  ██▐███   ██   ██  ██   ██  ██  ██
  7.  
  8.                           ▄▄▄ ▄▄▄    ▄▄▄▄     ▄▄▄▄▄▄
  9.    Designed -- Programmed █ █ █ █    █▄ █     █▄▄▄▄▀█     Beta Tested by
  10.              by           █▄▀█▀▄█     █ █     █▀▄▄▄██ Ray Martini - The Edge
  11.       Michael Hamilton     ▀█▄█▀      █▄█  ▄  █▄▄▄▄▄█      508-688-8657
  12.            of the                                         Fido 1:324/118
  13.      MysticWare/Hamsoft                                     As Well As
  14.       Developers Group                               B. Murphy - Business Card
  15.         508-689-4493                                       508-682-5329
  16.        Fido 1:324/131                                     Fido 1:324/121
  17.  
  18. Copyright (c) 1990 by Mike Hamilton - All rights reserved!
  19.  
  20. Table of contents -
  21.  
  22.         PART I - The Basics!
  23.                 Section I.i.........................Introduction
  24.                 Section I.ii........................Upgrading from 1.0
  25.                 Section I.iii.......................Installation
  26.                 Section I.iv........................Registering
  27.         PART II - The Works!
  28.                 Section II.i........................Borrowing
  29.                 Section II.ii.......................Depositing
  30.                 Section II.iii......................Lending
  31.                 Section II.iv.......................Robbing
  32.                 Section II.v........................Viewing
  33.                 Section II.vi.......................Withdrawing
  34.                 Section II.vii......................Statements
  35.         PART III - Extras!
  36.                 Section III.i.......................Support
  37.                         
  38.                             PART I - The Basics!
  39.  
  40. Section I.i - Introduction
  41.  
  42.         HamBank is, as the name implies, a Time Banking door for use on BBSs.
  43. Currently, HamBank only supports XBBS (a great BBS program written by Mark
  44. Kimes), QuickBBS (another good BBS program by the QuickBBS Group), and Remote
  45. Access (a QuickBBS clone).  If you would like to see HamBank run on your BBS
  46. software type, please contact the author (see Section I.iv - Contacting the
  47. Author).
  48.  
  49.         HamBank is the smallest sized and quickest running Time Bank that
  50. involves as much as this one does.  There are many functions available to
  51. your users when they are in HamBank.  They are:
  52.         [B]orrow Time                   (see Section II. - Borrowing)
  53.         [D]eposit Time                  (see Section II. - Depositing)
  54.         [L]end Time to a Friend         (see Section II. - Lending)
  55.         [Q]uit HamBank
  56.         [R]ob HamBank                   (see Section II. - Robbing)
  57.         [V]iew other Accounts           (see Section II. - Viewing)
  58.         [W]ithdraw Time                 (see section II. - Withdrawing)
  59.         [Y]our Account Statement        (see section II. - Statements)
  60.  
  61.         The registered version of HamBank will let you configure each and
  62. every color that is used in HamBank, as well as allow you to set the limit
  63. for the amount of time a user can deposit, the maximum amount the user can
  64. borrow and the borrowing interest rate, and the probability of a user
  65. successfully robbing the bank and how much he or she will win of everyone's
  66. time.  See the sample configuration file for the default values that are
  67. used.
  68.  
  69. Section I.ii - Upgrading from 1.0
  70.  
  71.         To upgrade to v1.2 from v1.0, simply replace the HamBank.Exe and
  72. TYM2*.Exe files found in your HamBank directory with the HamBank.Exe and
  73. TYM2*.Exe files located in the HAMBNK12 archive.  Delete HamBank.Wel - HamBank
  74. v1.2 no longer uses the encrypted welcome screen.  Read over WHATSNEW.1_2 that
  75. is found in the HAMBNK12 archive to find out what's been changed with the new
  76. version. That's all there is to it!
  77.  
  78. Section I.iii - Installation
  79.  
  80.         In order to run HamBank, you will need each file that came in the
  81. distribution archive.  A list of the files required follows.
  82.         HAMBANK.EXE     The actual program
  83.         HAMBANK.CFG     The configuration file
  84.         HAMBANK.CLR     The color configuration file
  85.         HAMBANK.WEL     The welcome screen for HamBank
  86.         TYM2XBBS.EXE    The program to save the users new time to XBBS
  87.         TYM2QBBS.EXE    The program to save the users new time to QuickBBS
  88.         HAMBANK.DOC     Documentation for HamBank (not necessary, really)
  89.  
  90.         Place all of the above files in a separate directory from your BBS
  91. directory (or in the same directory, but you really shouldn't clutter up
  92. your BBS directory TOO much!).  You MUST copy HAMBANK.WEL!  If this file is
  93. not present, HamBank will not run!  If it is altered, HamBank will not run!
  94. This is the only bit of 'security' I use.  I believe that since I wrote the
  95. program, I should at least have the right to tell people such!  Whew.
  96.  
  97.         If you have a registration number, edit the file HAMBANK.CFG.  It
  98. should look like this:
  99.                 Your Name
  100.                 Your BBS Name
  101.                 Registration Number
  102.                 Interest Rate for Borrowing Time
  103.                 Maximum borrowing amount
  104.                 Maximum depositing amount
  105.                 Percentage of times a robbery is successful
  106.                 Percentage of time the robber will win from accounts
  107.         You can have comments on any lines EXCEPT the first two.  Comments
  108. are anything that follows a semicolon.  You must not have comments BETWEEN
  109. lines, however.  The first two lines should appear EXACTLY the way that you
  110. sent to Mike Hamilton when you registered.
  111.  
  112.         With the registered version, you can also define all the colors
  113. that are used in HamBank.  Edit the file HAMBANK.CLR to do this.  Each line
  114. has a comment on it that describes what that line's color is for.  The
  115. available colors are:
  116.                 1 - Blue                5 - Magenta
  117.                 2 - Green               6 - Yellow
  118.                 3 - Cyan                7 - White
  119.                              4 - Red
  120.  
  121.         If you are running XBBS, you must create a menu option from one of
  122. your menus that loads a batch file.  You must either use the @Ed option or the
  123. @EsCommand.Com /C option! Otherwise, the new time reflected by HamBank will
  124. NOT be recognized by XBBS and thus defeat the purpose of a bank.  I use
  125. '@EdBankIt.Bat' as the command to load HamBank, you can also use
  126. '@EsCommand.Com /C BankIt.Bat'.  The batch file follows.
  127.  
  128.         If you are running QuickBBS, you MUST use a type 15 exit (as of
  129. QuickBBS v2.64).  Without a type 15 exit, the information placed in
  130. EXITINFO.BBS regarding the user's time will not be read by QuickBBS and the
  131. purpose of HamBank will yet again be defeated.
  132.  
  133.         You must now put HamBank in your batch file.  If you are using
  134. XBBS, you can put this batch file in your BBS directory.  I named the batch
  135. file 'BankIt.Bat' and it looks like this:
  136.              @Echo Off                  Don't want to see anything
  137.              CD \XBBS\HamBank           Change to HamBank directory
  138.              HamBank E:\XBBS            Load up HamBank
  139.              Tym2XBBS E:\XBBS           Put the new time in ONLINE.XBS
  140.              CD \XBBS                   Change back to XBBS dir
  141.              Exit                       Get back to the board
  142.         The sole paramater for HamBank and TYM2?BBS is the path to your BBS
  143. directory, or the directory that holds DORINFO1.DEF and ONLINE.XBS or
  144. EXITINFO.BBS.  If you decide to run HamBank out of your BBS directory, pass
  145. an asterisk on the command line (i.e.: HamBank.Exe *).
  146.  
  147.         If you are using QuickBBS, your batch file will be a bit different.
  148. In your main QuickBBS batch file (the one that loads up your mailer or
  149. QuickBBS), place an errorlevel check in it (the same errorlevel that you
  150. used in the type 15 menu command above).  An example would be:
  151.              :Start
  152.              QuickBBS -B%1 -T%3 -E0
  153.              Goto AfterQuick
  154.              :Restart
  155.              QuickBBS -R
  156.              :AfterQuick
  157.              If Errorlevel 55 goto HamBank     (HamBank ErrorLevel)
  158.              If Errorlevel 1 goto Error
  159.              goto out
  160.              :HamBank
  161.              CD \QBBS\HamBank
  162.              HamBank C:\QBBS
  163.              Tym2QBBS C:\QBBS
  164.              CD \QBBS
  165.              goto Restart
  166.              :out
  167.              Echo Done!
  168.         This is a very lengthy interpretation, and yet many things have
  169. been left out.  Nevertheless, you should catch the general idea of how to
  170. run HamBank under a QuickBBS environment.  If you have any problems with
  171. your batch files, feel free to contact the author.
  172.  
  173.         HamBank can have two commandline options.  They are:
  174.      B - Load HamBank only to return time for debts
  175.      M - Run HamBank in monochrome mode
  176.         Please read the WhatsNew file for a complete description of these two
  177. command line paramaters.  To pass a commandline paramater, simply run HamBank
  178. with 'HamBank <PathToExitFiles> [Parm1] [Parm2] ...'.  You MUST put the path
  179. to the exit files FIRST, and all paramaters after.
  180.  
  181.         The TYM2?BBS executable file that has been spoken about in this
  182. file should have come in the HamBank archive.  It is this file that updates
  183. your BBS software so it knows how much time the user has on-line after
  184. exiting HamBank.  IF HAMBANK DOES NOT SUPPORT YOUR FAVORITE BBS TYPE, AND
  185. YOU WISH IT TO, PLEASE CONTACT THE AUTHOR!
  186.  
  187. Section I.iv - Registering
  188.  
  189.         I spent a lot of time on HamBank, making sure it does what it is
  190. told and that it does not harm your board in any forseable way.  I think it
  191. is only fair that I be compensated for my efforts.  Therefor, I am asking
  192. you to send in a donation of $5 to register your copy of HamBank.
  193.  
  194.         When you register HamBank, many new options will be made available
  195. to you.  You will then be able to configure how much a user can borrow and
  196. the interest rate that is charged when borrowing.  You will be able to
  197. configure the maximum amount of time that a user can deposit in HamBank.
  198. Also, you will be able to configure the probability of a robbery being
  199. successful, as well as the percentage of time the robber will gain from
  200. everyone's account.  Finally, you will be able to define EACH AND EVERY
  201. color used by HamBank in it's normal operation.  That is quite a bit for a
  202. small $5 donation!  Please note, the $5 must be in US dollars; I currently
  203. have no means of accepting foreign currency.
  204.  
  205.         To register your copy of HamBank, send me a letter containing the
  206. following information: Your name, Your BBS's name, your FidoNet address (if
  207. applicable), your street address (with city, state, and zip!), and how you
  208. want me to return your registration number (by mail (will send it to the
  209. enclosed address), by NetMail (will send it to the enclosed FidoNet
  210. address), or by a voice phone call (please enclose your telephone number as
  211. well).  Send all the above information to:
  212.              MysticWare Registrations
  213.              c/o Mike Hamilton
  214.              310 Berry Street
  215.              North Andover, Ma, 01845
  216.         There is an enclosed file, HAMBANK.REG, which you can print out and
  217. use as your registration form.
  218.  
  219.                             PART II - The Works!
  220. Section II.i - Borrowing
  221.  
  222.         When a user picks 'B' from the menu, he will be shown a small
  223. screen explaining what borrowing means.  If your copy of HamBank is
  224. registered, he will be allowed to borrow up to the amount found in
  225. HamBank.Cfg (unlimited if the value in the CFG is 0) at the interest found
  226. in the config file as well.  Otherwise, HamBank will allow the user to
  227. borrow 45 minutes at an interest rate of 20%.
  228.  
  229.         A user will not be allowed to borrow time if he has time deposited
  230. in the bank.
  231.  
  232.         If a user decides to borrow, he will enter the amount he wishes to
  233. borrow (up to the maximum amount).  HamBank will then compute the interest
  234. and inform the user how much he must return to the bank to pay off the
  235. debt.
  236.  
  237.         When a user has borrowed time, any amount of time he deposits from
  238. that point on will be put towards paying off the debt.  Only after he has
  239. payed off the debt will he be allowed to borrow again or deposit into his
  240. account.  Even if he attempts to Rob the bank, his debt will still remain.
  241.  
  242. Section II.ii - Depositing
  243.  
  244.         A user will only be allowed to deposit up to the amount found in
  245. HamBank.Cfg (unlimited if HamBank is unregistered or the amount found in
  246. HamBank.Cfg is 0).  If the user has a debt to pay off, the amount the user
  247. deposits will be put toward his debt until the debt is completely payed
  248. off.  Otherwise, depositing time into the account works normally.
  249.  
  250. Section II.iii - Lending
  251.  
  252.         HamBank allows a user to lend some time to anyone else who is
  253. currently listed as a HamBank member.  The user must have time in his
  254. account to lend; this is an account transfer, NOT a deposit into someone
  255. else's account!
  256.  
  257.         After a brief explanation of lending time, the user will be
  258. prompted for the name of the person to lend time to.  After the user inputs
  259. this name, HamBank will scan the member list to see if the intended
  260. receiver actually uses HamBank.  If not, the user is brought back to the
  261. Main Menu.
  262.  
  263.         After finding the receiving user, HamBank will prompt the user for
  264. the amount to lend.  This can be any amount up to the amount deposited in
  265. the user's account.  If the amount the user wants to lend increases the
  266. receiver's account past the maximum value for a deposit, HamBank will not
  267. allow the transfer to be completed.  (I know that sounds really confusing,
  268. but you'll understand once you try it out...)
  269.  
  270.         Once time has been lended, it is impossible for the user to get his
  271. time back.
  272.  
  273.         Upon the next log on, the receiver is notified that he has received
  274. time.  The sender is reminded that he has lent money as well.
  275.  
  276. Section II.iv - Robbing
  277.  
  278.         Robbing the bank is a new idea.  What it entails is this.  The user
  279. has a certain probability of successfully robbing the bank.  If you have
  280. registered HamBank, the probability is completely up to you (line 7 in
  281. HamBank.CFG).  Otherwise, the probability is 40%.
  282.  
  283.         If the user fails in robbing the bank, he loses ALL time in his
  284. account AS WELL AS all time for his current call!  That'll teach 'em!
  285.  
  286.         If the user succeeds, he receives a percentage of everyone's
  287. account in HamBank.  That percentage, if you have registered HamBank, is
  288. configurable on line 8 of the config file.  Otherwise, it is always 75% of
  289. everyone's account.
  290.  
  291.         Everyone who's account is affected by the robbery is notified that
  292. they've been robbed and how much time was taken.  The identity of the
  293. robber is kept secret.
  294.  
  295. Section II.v - Viewing
  296.  
  297.         Viewing the other accounts is simple and very straightforward.  All
  298. it does is show the user a list of all the accounts in HamBank.  The format
  299. is: Account number - Name of user - Time in the bank.
  300.  
  301. Section II.vi - Withdrawing
  302.  
  303.         Withdrawing is very straightforward as well.  If the user has time
  304. in his account, he can withdraw it all or just a portion of it.  That
  305. amount is added to the remainder of his current call.
  306.  
  307. Section II.vii - Statements
  308.  
  309.         An account statement simply tells the user:
  310. 1)  If he has been robbed or not
  311. 2)  How much time he has in the account
  312. 3)  How much time he has borrowed
  313. 4)  How much time he has lent out and to whom
  314. 5)  How much time he has received and from whom
  315. 6)  If HamBank is registered, who it has been registered to
  316.  
  317.                             PART III - Extras!
  318. Section III.i - Support
  319.  
  320.         I will support HamBank in the following way:
  321.  
  322.         If you have any suggestions or (shudder) problems, there are a
  323. multitude of ways you can get in touch with me.  Please pick one of the
  324. following:
  325.  
  326.         1) Send a NetMail message to Mike Hamilton at 1:324/131.  This is
  327. by far the best way to get in touch with me since I'll most likely reply
  328. within a few hours.
  329.  
  330.         2) Log on to The Mystic Tribunal at (508)689-4493 and comment to
  331. Mike Hamilton.  The latest versions of any MysticWare are always
  332. downloadable on your first call.  Or, you can call any one of the
  333. MysticWare support boards. They are:
  334.  
  335. The New EDGE BBS   (508)688-8657  Fido 1:324/118  Lawrence, Ma. (2400)
  336. The Business Card  (508)682-5329  Fido 1:324/121  Lawrence, Ma. (14.4DS)
  337. FunTime BBS        (201)273-8709                  Summit, NJ.   (2400)
  338.  
  339.         3) You are also able to pick up the 'MYSTICWARE' echo from me or
  340. any of the above listed support BBSs.  If things go right, MYSTICWARE may
  341. even be on the backbone shortly!
  342.  
  343.         4) The worst you could do would be to send SnailMail to MysticWare,
  344. c/o Mike Hamilton at 310 Berry Street, North Andover, Ma, 01845.  This is a
  345. slow method, but if that's the way it has to be done, there's no stopping
  346. it.
  347.  
  348.